docs: add event-driven automation prerequisites and setup guides#501
Draft
xingyaoww wants to merge 1 commit into
Draft
docs: add event-driven automation prerequisites and setup guides#501xingyaoww wants to merge 1 commit into
xingyaoww wants to merge 1 commit into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
474ede5 to
c0dcdfa
Compare
xingyaoww
pushed a commit
that referenced
this pull request
May 28, 2026
Event-driven automation setup docs are moving to PR #501. Remove the Automate This section and fix the automations/overview.mdx link to not reference the now-removed #automate-this anchor. Co-authored-by: openhands <openhands@all-hands.dev>
xingyaoww
added a commit
that referenced
this pull request
May 28, 2026
* docs: add Automated QA Testing page Add qa-changes.mdx with full QA agent documentation: - Four-phase methodology (Understand → Setup → Exercise → Report) - GitHub Actions and in-conversation quick start - QA report format with examples - Customization and repo-specific QA guidelines - Integration with the Verification Stack Also adds nav entry in docs.json and overview card. Co-authored-by: openhands <openhands@all-hands.dev> * fix: resolve CI failures — broken links and automation sync - Replace internal verification-stack links with external URLs (blog post and extensions repo) since that page hasn't landed on main yet - Run sync_use_case_automations.py to update automations/overview.mdx Co-authored-by: openhands <openhands@all-hands.dev> * fix: add missing 'Automate This' section to qa-changes.mdx Addresses review feedback — automations/overview.mdx links to qa-changes#automate-this but the anchor didn't exist. Every other use-case page has this section; now qa-changes does too. Co-authored-by: openhands <openhands@all-hands.dev> * fix: address review feedback — pin action ref, fix model ID, soften retry language - Pin GitHub Action to @v1 instead of @main for reproducible builds - Use valid model ID anthropic/claude-sonnet-4-20250514 - Soften hard-coded retry count language to avoid docs going stale Co-authored-by: openhands <openhands@all-hands.dev> * fix: add skill install step before /qa-changes invocation Users need to install the skill first via /add-skill before running /qa-changes in a conversation. Without this, they get a skill not found error. Co-authored-by: openhands <openhands@all-hands.dev> * fix: revert action pin to @main — @v1 tag does not exist OpenHands/extensions does not publish release tags yet, so @v1 is not available. Revert to @main for now. Co-authored-by: openhands <openhands@all-hands.dev> * fix: revert @v1 pin to @main, document extensions has no release tags OpenHands/extensions does not publish versioned tags. Reverts the action reference to @main and adds a note to AGENTS.md so future agents and reviewers don't repeat this mistake. Co-authored-by: openhands <openhands@all-hands.dev> * fix: correct custom QA guide filename and name to match extensions repo The extensions README documents the skill file as .agents/skills/qa-guide.md with name: qa-guide, not custom-qa-guide.md. Align docs to match the actual upstream example. Co-authored-by: openhands <openhands@all-hands.dev> * fix: remove Automate This section from qa-changes.mdx Event-driven automation setup docs are moving to PR #501. Remove the Automate This section and fix the automations/overview.mdx link to not reference the now-removed #automate-this anchor. Co-authored-by: openhands <openhands@all-hands.dev> --------- Co-authored-by: openhands <openhands@all-hands.dev>
c0dcdfa to
472a3bb
Compare
472a3bb to
457121e
Compare
event-automations.mdx: - Add 'Prerequisites for GitHub Event Automations' section with step-by-step setup: GitHub App install, team org creation, org claim, service accounts - Add troubleshooting accordion for silent event drops code-review.mdx: - Replace generic 'Automate This' with full 'OpenHands Automations' section - Add Warning callout: set up event-driven automations + enable org feature - Complete copy-paste prompt for PR review automation - Trigger events, filter, session URL, progress comment documentation - Single-repo vs org-wide configuration and testing instructions qa-changes.mdx: - Add 'Automate This' section with Warning callout matching code-review - Copy-paste prompt for automated QA on PRs using qa-changes plugin Co-authored-by: openhands <openhands@all-hands.dev>
457121e to
75da75c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds documentation for setting up event-driven GitHub automations on OpenHands Cloud, including prerequisites, setup guides, and prerequisite callouts on the Code Review and QA Testing pages.
Changes
openhands/usage/automations/event-automations.mdx(+79 lines)<Warning>)openhands/usage/use-cases/code-review.mdx(+124/−12 lines)<Warning>callout directing users to:openhands/usage/use-cases/qa-changes.mdx(+27 lines)<Warning>callout for event-driven automation prerequisitesThis PR was created by an AI agent (OpenHands) on behalf of the user.